<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.obj._object._ObjectRootProp</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.obj-module.html">Package&nbsp;obj</a> ::
        <a href="py2ecotect.obj._object-module.html" onclick="show_private();">Module&nbsp;_object</a> ::
        Class&nbsp;_ObjectRootProp
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.obj._object._ObjectRootProp-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class _ObjectRootProp</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">_ObjectRootProp</strong>
</pre>

<dl><dt>Known Subclasses:</dt>
<dd>
      <ul class="subclass-list">
<li><a href="py2ecotect.obj._object._Object.prop-class.html">_Object.prop</a></li>  </ul>
</dd></dl>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootProp-class.html#get_angle" class="summary-sig-name">get_angle</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span><br />
      Returns the angle, in degrees, of the surface normal of a planar 
      object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.get_angle">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootProp-class.html#get_flag" class="summary-sig-name">get_flag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">flag</span>)</span><br />
      In ECOTECT, objects have a range of boolean flags associated with 
      them that are used at various times.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.get_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootProp-class.html#set_flag" class="summary-sig-name">set_flag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">flag</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      In ECOTECT, objects have a range of boolean flags associated with 
      them that are used at various times.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.set_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootProp-class.html#get_tag" class="summary-sig-name">get_tag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tag</span>)</span><br />
      Retrieves information about tags that have been assigned to the 
      specified object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.get_tag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootProp-class.html#set_tag" class="summary-sig-name">set_tag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tag</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      Sets tags for the specified object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.set_tag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="attr_2"></a><span class="summary-name">attr_2</span> = <code title="None">None</code>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#eco_id" class="summary-name">eco_id</a><br />
      Id of the object
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#area" class="summary-name">area</a><br />
      Retrieves the surface area for the specified object, measured in 
      square metres.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#attr_1" class="summary-name">attr_1</a><br />
      Retrieves the calculated value stored as Attribute Number 1 for the 
      specified object.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#attr_3" class="summary-name">attr_3</a><br />
      Retrieves the calculated value stored as Attribute Number 3 for the 
      specified object.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#center" class="summary-name">center</a><br />
      Returns three decimal values corresponding to the X, Y and Z 
      components of geometric centre for the specified object.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#element_type" class="summary-name">element_type</a><br />
      Returns the element type of the specified object, according to the 
      values in the Element Types table.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#equation" class="summary-name">equation</a><br />
      Getting this property returns the values used to calculate the plane 
      equation for the specified object.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#length" class="summary-name">length</a><br />
      Retrieves the length value for the specified object, measured in 
      millimetres.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#link" class="summary-name">link</a><br />
      Getting this property returns the absolute index of the object to 
      which the specified object is linked.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#mask" class="summary-name">mask</a><br />
      Retrieves the index of the object's shading mask.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#normal" class="summary-name">normal</a><br />
      Retrieves the values corresponding to the x, y and z axis components 
      for the normal of the specified object.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#panel_area" class="summary-name">panel_area</a><br />
      Retrieves the surface area value overlapping with a WINDOW or DOOR 
      object in an adjacent zone, measured in square metres.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#resolution" class="summary-name">resolution</a><br />
      Retrieves the current curve resolution to use for virtual polylines, 
      for the specified object.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#schedule" class="summary-name">schedule</a><br />
      Retrieves the index value for the specified object's activation 
      schedule.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootProp-class.html#vector" class="summary-name">vector</a><br />
      Retrieves the extrusion vector of the specified object.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="get_angle"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_angle</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">type</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.get_angle">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the angle, in degrees, of the surface normal of a planar 
  object.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>type What the surface normal angle is measured in relation to, and may
  be given as a token or value corresponding to the Object Angles 
  table.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>angle The resulting angle in degrees.</p>
  <p>Relevant Data Table(s)</p>
  <p>Object Angles Token Value Description azimuth 0 Angle of surface in 
  horizontal plane to positive Y axis. altitude 1 Angle of surface in 
  vertical plane with the ground. sunangle 2 3D angle between surface 
  normal and current sun position. north 3 Angle of surface in horizontal 
  plane to current North Point. eye 4 3D angle between surface normal and 
  current eye position.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_flag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">flag</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.get_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>In ECOTECT, objects have a range of boolean flags associated with them
  that are used at various times. This command retrieves the nominated flag
  settings for the specified object.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>flag An integer value representing a binary bit, as shown in the 
  Object Flags table below. To test multiple flags at once, simply add 
  their values together.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A value representing whether the particular flag is set or not. 
  This is a boolean value where 1 represents the affirmative and 0 the 
  negative.</p>
  <p>Relevant Data Table(s)</p>
  <p>Object Flag Codes Value Description Notes 1 OBJECT_POINT Object is a 
  single-node point. 2 OBJECT_VECTOR Object is a direction vector. 4 
  OBJECT_PLANAR  Object is a flat surface with an equation. 8 OBJECT_CLOSED
  Objects is a closed loop. 16 OBJECT_POLYLINE Object defines a virtual 
  polyline. 32 OBJECT_EXTRUSION Object is formed from the extrusion of its 
  parent. 64 OBJECT_EXTRUDED Object has been extruded. 128 OBJECT_COPLANAR 
  Object is linked to another as coplanar. 256 OBJECT_INSIDE Object is 
  linked to another as inside it's extents. 512 OBJECT_CONCAVE Object is a 
  complex/concave polygon. 1024 OBJECT_PARENT Object is the parent of 
  another. 2048 OBJECT_CHILD Object is the child of another. 4096 
  OBJECT_ZONE Object defines a model zone. 8192 OBJECT_PLANE_EQN* User has 
  specified particular nodes to generate equation. 16384 OBJECT_REVERSE 
  Object's surface normal is reversed. 32768 OBJECT_SEE_THRU Object is 
  partially transparent.</p>
  <p>*Indicates temporary and volatile markers for internal use only.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_flag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">flag</span>,
        <span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.set_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>In ECOTECT, objects have a range of boolean flags associated with them
  that are used at various times. This command sets the nominated flag 
  settings for the specified object.</p>
  <p>Important Note: Flags are fundamental to how the model works. Be very 
  careful before setting any of them manually, and always operate on files 
  for which you have up-to-date backups. Incorrect usage of flags can 
  corrupt your model beyond repair (ECOTECT probably shouldn't allow these 
  values to be set via a script, however someone will have a valid reason 
  at some stage, and if the user cannot be trusted, who can be 
  trusted?).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>flag An integer value representing a binary bit, as shown in the 
  Object Flags table. To set multiple flags at once, add their values 
  together.</p>
  <p>[state] An optional parameter that determines whether to set or reset 
  the flag(s). This is a boolean value where 1 or true represents the 
  affirmative and 0 or false the negative.</p>
  <p>Relevant Data Table(s)</p>
  <p>Object Flag Codes Value Description Notes 1 OBJECT_POINT Object is a 
  single-node point. 2 OBJECT_VECTOR Object is a direction vector. 4 
  OBJECT_PLANAR  Object is a flat surface with an equation. 8 OBJECT_CLOSED
  Objects is a closed loop. 16 OBJECT_POLYLINE Object defines a virtual 
  polyline. 32 OBJECT_EXTRUSION Object is formed from the extrusion of its 
  parent. 64 OBJECT_EXTRUDED Object has been extruded. 128 OBJECT_COPLANAR 
  Object is linked to another as coplanar. 256 OBJECT_INSIDE Object is 
  linked to another as inside it's extents. 512 OBJECT_CONCAVE Object is a 
  complex/concave polygon. 1024 OBJECT_PARENT Object is the parent of 
  another. 2048 OBJECT_CHILD Object is the child of another. 4096 
  OBJECT_ZONE Object defines a model zone. 8192 OBJECT_PLANE_EQN* User has 
  specified particular nodes to generate equation. 16384 OBJECT_REVERSE 
  Object's surface normal is reversed. 32768 OBJECT_SEE_THRU Object is 
  partially transparent.</p>
  <p>*Indicates temporary and volatile markers for internal use only.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_tag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_tag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">tag</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.get_tag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves information about tags that have been assigned to the 
  specified object. Tags are simply indicators to ECOTECT that the object 
  performs additional functions or is specifically marked for certain 
  calculations.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>tag An integer value representing a binary bit, as shown in the Object
  Tags table. The value returned for the nominated tag will be a boolean 
  integer value - 0 for off, or 1 for on.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A value representing whether the particular tag is set or not. 
  This is a boolean value where 1 represents the affirmative and 0 the 
  negative.</p>
  <p>Relevant Data Table(s)</p>
  <p>Object Tag Codes Value Description Notes 1 TAGGED_PICKED* User clicked
  near one of it's lines. 2 TAGGED_PREVIOUS* Part of the previous selection
  set. 16 TAGGED_SHOWVALUE Object has valid assigned attribute values. 32 
  TAGGED_SHADED Shadows are cast onto this object. 64 TAGGED_ERROR Object 
  has violated an inter-object relationship. 128 TAGGED_UPDATE Object has 
  changed and needs an update. 256 TAGGED_MIRROR Object produces solar 
  reflections. 512 TAGGED_ACOUSTIC Object is tagged as an acoustic 
  reflector. 4096 TAGGED_3PTS_CONCAVE First 3 nodes are concave. 16384 
  TAGGED_INCOMPLETE Object being created - nodes still being added. 32768 
  TAGGED_MARKER* Generic calculation marker.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_tag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_tag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">tag</span>,
        <span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootProp.set_tag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets tags for the specified object. Tags are simply indicators to 
  ECOTECT that the object performs additional functions or is specifically 
  marked for certain calculations. To test multiple tags at once, simply 
  add their values together. The optional [true|false] parameter determines
  whether set or reset the tag(s), defaulting to true.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>tag An integer value representing a binary bit, as shown in the Object
  Tags table. To test multiple tags at once, simply add their values 
  together.</p>
  <p>[state] An optional parameter determining whether to set or reset the 
  tag(s). This is a boolean value where 1 or true represents the 
  affirmative and 0 or false the negative. If not given, it defaults to 
  true.</p>
  <p>Relevant Data Table(s)</p>
  <p>Object Tag Codes Value Description Notes 1 TAGGED_PICKED* User clicked
  near one of it's lines. 2 TAGGED_PREVIOUS* Part of the previous selection
  set. 16 TAGGED_SHOWVALUE Object has valid assigned attribute values. 32 
  TAGGED_SHADED Shadows are cast onto this object. 64 TAGGED_ERROR Object 
  has violated an inter-object relationship. 128 TAGGED_UPDATE Object has 
  changed and needs an update. 256 TAGGED_MIRROR Object produces solar 
  reflections. 512 TAGGED_ACOUSTIC Object is tagged as an acoustic 
  reflector. 4096 TAGGED_3PTS_CONCAVE First 3 nodes are concave. 16384 
  TAGGED_INCOMPLETE Object being created - nodes still being added. 32768 
  TAGGED_MARKER* Generic calculation marker.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="eco_id"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">eco_id</h3>
  <p>Id of the object</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Id of the object
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">area</h3>
  <p>Retrieves the surface area for the specified object, measured in 
  square metres.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the requested object data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the surface area for the specified object, measured in square 
metres.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="attr_1"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">attr_1</h3>
  <p>Retrieves the calculated value stored as Attribute Number 1 for the 
  specified object.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the requested object data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the calculated value stored as Attribute Number 1 for the 
specified object.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the calculated value stored as Attribute Number 1 for the specified 
object.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="attr_3"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">attr_3</h3>
  <p>Retrieves the calculated value stored as Attribute Number 3 for the 
  specified object.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the requested object data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the calculated value stored as Attribute Number 3 for the 
specified object.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the calculated value stored as Attribute Number 3 for the specified 
object.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="center"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">center</h3>
  <p>Returns three decimal values corresponding to the X, Y and Z 
  components of geometric centre for the specified object. The values of 
  the object centre are given in absolute world coordinates.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z Represents the absolute position in the X, Y and Z axis of the
  centre point in 3 dimensional model space.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns three decimal values corresponding to the X, Y and Z components of 
geometric centre for the specified object.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">absolute_position</span>)</span>
        - Sets the centre point for the specified object - the object is moved so 
that its center is aligned to the point specified.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="element_type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">element_type</h3>
  <p>Returns the element type of the specified object, according to the 
  values in the Element Types table.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>type An integer value corresponding to the Element Types table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Element Types Token Value void 0 roof 1 floor 2 ceiling 3 wall 4 
  partition 5 window 6 panel 7 door 8 point 9 speaker 10 light 11 appliance
  12 line 13 solarcollector 14 camera 15</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the element type of the specified object, according to the values 
in the Element Types table.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span>
        - Sets the specified object as the given element type.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="equation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">equation</h3>
  <p>Getting this property returns the values used to calculate the plane 
  equation for the specified object.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>A, B, C, D Four decimal values corresponding to A, B, C and D from the
  plane equation: Ax + By + Cz = D</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Getting this property returns the values used to calculate the plane 
equation for the specified object.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>)</span>
        - When this property is set, ECOTECT recalculates the plane equation Ax + By 
+ Cz = D for the specified object.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="length"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">length</h3>
  <p>Retrieves the length value for the specified object, measured in 
  millimetres. This command only works on linear objects.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the requested object data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the length value for the specified object, measured in 
millimetres.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="link"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">link</h3>
  <p>Getting this property returns the absolute index of the object to 
  which the specified object is linked. If the object is not linked to any 
  other object, it returns a value of -1.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>link The zero-based index of the linked object.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Getting this property returns the absolute index of the object to which the
specified object is linked.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="mask"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">mask</h3>
  <p>Retrieves the index of the object's shading mask. The shading mask 
  assigned to each object determines when and by how much the object is 
  overshadowed at any particular time.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>mask An integer value between -1 and the value given by 
  get.masks.count - 1, being the zero-based index of the shading mask in 
  the current list.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the index of the object's shading mask.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span>
        - Sets the index of the object's shading mask.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="normal"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">normal</h3>
  <p>Retrieves the values corresponding to the x, y and z axis components 
  for the normal of the specified object. Note that all surface normals in 
  ECOTECT are normalised such that they are of unit length (ie: length = 
  1.0).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dx, dy, dz A vector value representing the offset distance in each of 
  the X, Y and Z axis, given in model coordinates, of the object's 
  normal.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the values corresponding to the x, y and z axis components for 
the normal of the specified object.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="panel_area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">panel_area</h3>
  <p>Retrieves the surface area value overlapping with a WINDOW or DOOR 
  object in an adjacent zone, measured in square metres.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the requested object data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the surface area value overlapping with a WINDOW or DOOR object 
in an adjacent zone, measured in square metres.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="resolution"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">resolution</h3>
  <p>Retrieves the current curve resolution to use for virtual polylines, 
  for the specified object.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the requested object data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current curve resolution to use for virtual polylines, for 
the specified object.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the curve resolution to use for virtual polylines, for the specified 
object.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="schedule"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">schedule</h3>
  <p>Retrieves the index value for the specified object's activation 
  schedule. The activation schedule determines when and how much an object 
  is turned on or off.</p>
  <p>It is also possible to access all schedule properties this way. Thus, 
  you could use something like get(&quot;object.schedule.name&quot;, 23) to
  retrieve data from the schedule assigned to this object. See the schedule
  object for more details.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>schIndex The zero-based index of the schedule assigned to this 
  object.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the index value for the specified object's activation schedule.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">schedule</span>)</span>
        - Sets the index value to use for the specified object's activation schedule.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="vector"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">vector</h3>
  <p>Retrieves the extrusion vector of the specified object.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dx, dy, dz A vector value representing the offset distance in each of 
  the X, Y and Z axis, given in model coordinates, of the object's 
  extrusion vector.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the extrusion vector of the specified object.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">vector</span>)</span>
        - Sets the extrusion vector of the specified object.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:48 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
